IssuesTest.java

package org.javabuilders.swing.test;

import static org.junit.Assert.*;

import java.awt.event.ActionEvent;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;
import java.io.IOException;
import java.util.ResourceBundle;

import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDesktopPane;
import javax.swing.JFrame;
import javax.swing.JInternalFrame;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JPasswordField;
import javax.swing.JSpinner;
import javax.swing.JTextField;
import javax.swing.KeyStroke;
import javax.swing.event.ListSelectionEvent;

import net.miginfocom.swing.MigLayout;

import org.javabuilders.BuildException;
import org.javabuilders.BuildResult;
import org.javabuilders.Builder;
import org.javabuilders.event.BackgroundEvent;
import org.javabuilders.handler.validation.ICustomValidator;
import org.javabuilders.handler.validation.ValidationMessage;
import org.javabuilders.handler.validation.ValidationMessageList;
import org.javabuilders.swing.SwingJavaBuilder;
import org.javabuilders.swing.controls.JBSeparator;
import org.javabuilders.swing.handler.event.background.BackgroundDialog;
import org.javabuilders.swing.test.issues.resources.CustomGenericPanel;
import org.javabuilders.swing.test.issues.resources.Issue10;
import org.javabuilders.swing.test.issues.resources.Issue11;
import org.javabuilders.swing.test.issues.resources.Issue125;
import org.javabuilders.swing.test.issues.resources.Issue12_JPopupMenuException;
import org.javabuilders.swing.test.issues.resources.Issue17_JMenuBarInJDialog;
import org.javabuilders.swing.test.issues.resources.Issue20_DuplicateNames;
import org.javabuilders.swing.test.issues.resources.Issue20_NoYaml;
import org.javabuilders.swing.test.issues.resources.Issue23_Exception;
import org.javabuilders.swing.test.issues.resources.Issue67;
import org.javabuilders.swing.test.issues.resources.Issue7;
import org.javabuilders.swing.test.issues.resources.Issue77;
import org.javabuilders.swing.test.issues.resources.IssueNullValue;
import org.javabuilders.swing.test.issues.resources.IssueNullValue2;
import org.javabuilders.swing.test.issues.resources.issue57.BeanTableModel;
import org.javabuilders.swing.test.issues.resources.issue57.BeanTableModelFrame;
import org.javabuilders.swing.util.SwingYamlBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;

/**
 * Tests for all submitted issues
 * @author Jacek Furmankiewicz
 */
public class IssuesTest {

	@Before
	public void setUp() {
		SwingJavaBuilder.getConfig().addType(BeanTableModel.class);
	}

	@After
	public void tearDdown() {
		SwingJavaBuilder.getConfig().removeType(BeanTableModel.class);
	}

	@Test
	public void issue7Test() throws Exception {
		JPanel panel = new Issue7();
		
		JLabel label = (JLabel)panel.getComponent(0);
		assertEquals("someLabel",label.getName());
		
		JTextField field = (JTextField)panel.getComponent(1);
		assertEquals("someTextField",field.getName());
		
		JPanel panel2 = (JPanel)panel.getComponent(2);
		assertEquals("childPanel",panel2.getName());
		
		JButton button = (JButton)panel2.getComponent(0);
		assertEquals("someButton", button.getName());
		
	}
	
	@Test
	public void issue10Test() throws Exception {
		@SuppressWarnings("unused")
		JFrame frame = new Issue10();
	}
	
	
	@Test
	@Ignore("Ignore for now until we move up to JDK 6")
	public void issue11Test() throws Exception {
		Issue11 issue = new Issue11();
		
		assertNotNull("PopupMenu instance is null",issue.getPopup());
		assertNotNull("JPopupMenu instance is null",issue.getJpopup());
	}
	
	@Test
	public void issue12Test() throws Exception {
		Issue12_JPopupMenuException test = new Issue12_JPopupMenuException();
		test.dispose();
	}
	
	@Test
	public void issueNullValueTest() {
		IssueNullValue test = new IssueNullValue();
		test.dispose();
	}

	@Test
	public void issueNullValue2Test() {
		IssueNullValue2 test = new IssueNullValue2();
		test.dispose();
	}
	
	@Test
	public void issue17Test_JMenuBarInJDialog() {
		Issue17_JMenuBarInJDialog dialog = new Issue17_JMenuBarInJDialog();
		
		assertNotNull("menu is null",dialog.menuBar);
		assertNotNull("JDialog,getJMenuBar()is null",dialog.getJMenuBar());
		assertEquals("dialog.menuBar != dialog.getJMenuBar()", dialog.getJMenuBar(), dialog.menuBar);
	}
	
	@Test
	public void issue19_JBSeparatorTextLocalized() {
		String yaml= "JBSeparator(text=button.ok)";
		JBSeparator sep = new JBSeparator();
		ResourceBundle bundle = ResourceBundle.getBundle("TestResources");
		
		SwingJavaBuilder.build(sep, yaml, bundle);
		
		assertEquals("JBSeparator.text not localized", bundle.getString("button.ok"), sep.getText());
	}
	
	@Test
	public void issue21_FailToInvokeMethodWithAncestorSignature() {
		String yaml = "JButton(onAction=issue21)";
		JButton button = new JButton("Test") {
			private void issue21(JComponent c, ActionEvent evt) {
			}
		};
		
		SwingJavaBuilder.build(button, yaml);
		button.doClick();
	}
	
	@Test
	public void issue23_Exception() {
		Issue23_Exception frame = new Issue23_Exception();
	}
	
	/**
	 * If no YAML file found, a proper BuildException should be thrown instead of NullPointerException
	 */
	@Test(expected=BuildException.class)
	public void issue20_NoYaml() {
		Issue20_NoYaml panel = new Issue20_NoYaml();
	}
	
	/**
	 * Properly throw an error if duplicate names are defined in the YAML file
	 */
	@Test(expected=BuildException.class)
	public void issue20_duplicateNames() {
		Issue20_DuplicateNames panel = new Issue20_DuplicateNames();
		
	}
	
	/**
	 * Test that fetching icons via direct path works
	 */
	@Test
	public void issue18_directIconPath() {
		
		String yaml="JButton(name=button,icon=issues/resources/document-new.png)";
		JButton button = (JButton) Builder.buildFromString(SwingJavaBuilder.getConfig(), this, yaml).get("button");
		assertNotNull("JButton.icon was null", button.getIcon());
	}
	
	/**
	 * Test that fetching icons via resource bundles works
	 */
	@Test
	public void issue18_bundleIconPath() {
		String yaml="JButton(name=button,icon=icon.issue18)";
		JButton button = (JButton) Builder.buildFromString(SwingJavaBuilder.getConfig(), this, yaml, ResourceBundle.getBundle("TestResources")).get("button");
		assertNotNull("JButton.icon was null", button.getIcon());
	}
	
	/**
	 * Test that fetching icons via direct path works
	 */
	@Test
	public void issue18_directIconImagePath() {
		
		String yaml="JFrame(name=frame,iconImage=issues/resources/document-new.png)";
		JFrame frame= (JFrame) Builder.buildFromString(SwingJavaBuilder.getConfig(), this, yaml).get("frame");
		assertNotNull("JFrame.image was null", frame.getIconImage());
	}
	
	/**
	 * Test that fetching icons via resource bundles works
	 */
	@Test
	public void issue18_bundleIconImagePath() {
		String yaml="JFrame(name=frame,iconImage=icon.issue18)";
		JFrame frame= (JFrame) Builder.buildFromString(SwingJavaBuilder.getConfig(), this, yaml, ResourceBundle.getBundle("TestResources")).get("frame");
		assertNotNull("JFrame.image was null", frame.getIconImage());
	}
	
	@Test
	public void issue47_chainedConfirmValidate() {
		String yaml="JButton(name=button,onAction=[$confirm,$validate])";
		JButton button = (JButton) SwingJavaBuilder.build(this, yaml).get("button");
		assertNotNull(button.getActionListeners());
		assertEquals(1,button.getActionListeners().length);
	}
	
	
	@Test
	public void issue48_customValidator() {

		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JTextField(name=text)");
			validate();
			___("- text.text: {mandatory: true}");
			
		}}.build(this);
		
		JTextField text = (JTextField) r.get("text");
		assertNotNull(text);
		assertFalse(r.validate(false)); //validation should fail
		text.setText("TEST");
		assertTrue(r.validate(false)); //validation should pass
		
		//add custom validator
		r.getValidators().add(new ICustomValidator() {
			public void validate(ValidationMessageList list) {
				list.add(new ValidationMessage("TEST"));
			}
		});
		
		assertFalse(r.validate(false)); //validation should fail
		ValidationMessageList list = r.getValidationMessages();
		assertEquals(1,list.size());
		assertEquals("TEST",list.get(0).getMessage());
		
		//validate again, should still be the same
		assertFalse(r.validate(false)); //validation should fail
		list = r.getValidationMessages();
		assertEquals(1,list.size());
		assertEquals("TEST",list.get(0).getMessage());
		
		//make both standard and custom fail - we should have 2 error messages
		text.setText(null);
		
		assertFalse(r.validate(false)); //validation should fail
		list = r.getValidationMessages();
		assertEquals(2,list.size());
		assertEquals("TEST",list.get(1).getMessage());
		
		text.setText("");
		assertFalse(r.validate(false)); //validation should fail
		list = r.getValidationMessages();
		assertEquals(2,list.size());
		assertEquals("TEST",list.get(1).getMessage());
	}
	

	//variation where the custom validator is added BEFORE the first validate
	@Test
	public void issue48_customValidator2() {

		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JTextField(name=text)");
			validate();
			___("- text.text: {mandatory: true}");
			
		}}.build(this);

		//add custom validator
		r.getValidators().add(new ICustomValidator() {
			public void validate(ValidationMessageList list) {
				if (list.size() > 0) {
					//only add error if another one exists
					list.add(new ValidationMessage("TEST"));
				}
			}
		});
		
		JTextField text = (JTextField) r.get("text");
		assertNotNull(text);
		assertFalse(r.validate(false)); //validation should fail
		ValidationMessageList list = r.getValidationMessages();
		assertEquals(2,list.size());
		assertEquals("TEST",list.get(1).getMessage());
		
		text.setText("TEST");
		assertTrue(r.validate(false)); //validation should pass
		assertEquals(0, r.getValidationMessages().size());
	}
	
	@Test
	public void issue50_referenceSuperclassProtectedVariables() {
		CustomGenericPanel panel = new CustomGenericPanel();
		
		assertNotNull("superclass text field is null",panel.getGenericTextField());
		assertNotNull("class text field is null",panel.getCustomTextField());
		
	}
	
	@Test
	public void issue52_onSelectionForJList() {
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JList(name=list,onSelection=jlist_selection)");
		}}.build(this);

		JList list = (JList) r.get("list");
		assertNotNull(list);
		assertEquals(1,list.getListSelectionListeners().length);
	}
	
	@Test
	public void issue52_onSelectionForJListMultiple() {
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JList(name=list,onSelection=[jlist_selection,jlist_selection2])");
		}}.build(this);

		JList list = (JList) r.get("list");
		assertNotNull(list);
		assertEquals(1,list.getListSelectionListeners().length);
	}
	
	@Test(expected=BuildException.class)
	public void issue52_onSelectionForJListInvalid() {
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JList(name=list,onSelection=jlist2_selection)"); //wrong method name
		}}.build(this);

		JList list = (JList) r.get("list");
		assertNotNull(list);
	}

	//needed for a test
	private void jlist_selection(ListSelectionEvent evt) {
		//do nothing
	}

	//needed for a test
	private void jlist_selection2(ListSelectionEvent evt) {
		//do nothing
	}
	
	@Test
	public void issue53_noActionsUnderJPanel() {

		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- Action(name=text)");
		}}.build(this);

	}

	@Test
	public void issue57_NPEonCustomTableModel() {
		BeanTableModelFrame frame = new BeanTableModelFrame();
	}
	
	@Test
	public void issue59_JSpinnerResize() {
		
		JPanel test = new JPanel();
		
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JSpinner(name=spinner)");
			___("- MigLayout: |");
			___("    [grow]");
			___("    spinner");
		}}.build(test);
		
		JPanel panel = (JPanel) r.getRoot();
		assertNotNull(panel);
		JSpinner spinner = (JSpinner) r.get("spinner");
		assertNotNull(spinner);
		MigLayout layout = (MigLayout) panel.getLayout();
		String c = (String) layout.getComponentConstraints(spinner);
		assertTrue(c.contains("growx"));
	}
	
	@Test
	public void issue58_mnemonicsAndAcceleratorsOnAbstractButtons() {
		BuildResult r = new SwingYamlBuilder("JFrame:") {{
			___("- JMenuBar:");
			_____("- JMenuItem(name=menu1,text='&New...\\tCtrl+N')");
			_____("- JMenuItem(name=menu2,text='&New')");
			_____("- JMenuItem(name=menu3,text='New...\\tCtrl+N')");
			_____("- JMenuItem(name=menu4,text='New')");
			_____("- JMenuItem(name=menu5,text='New...\\tF1')");
			___("- JPanel:");
			_____("- JButton(name=button1,text='New')");
			_____("- JButton(name=button2,text='&New')");
		}}.build(this);
		
		KeyStroke ctrlN = KeyStroke.getKeyStroke(KeyEvent.VK_N, InputEvent.CTRL_MASK);
		KeyStroke f1 = KeyStroke.getKeyStroke("F1");
		
		//mnemonics and accelerator
		JMenuItem item = (JMenuItem) r.get("menu1");
		assertEquals("New...", item.getText());
		assertEquals(KeyEvent.VK_N,item.getMnemonic());
		assertEquals(ctrlN,item.getAccelerator());
		
		//mnemonnic only
		item = (JMenuItem) r.get("menu2");
		assertEquals("New", item.getText());
		assertEquals(KeyEvent.VK_N,item.getMnemonic());
		assertEquals(null,item.getAccelerator());
		
		//accelerator only
		item = (JMenuItem) r.get("menu3");
		assertEquals("New...", item.getText());
		assertEquals(0,item.getMnemonic());
		assertEquals(ctrlN,item.getAccelerator());
		
		//text only
		item = (JMenuItem) r.get("menu4");
		assertEquals("New", item.getText());
		assertEquals(0,item.getMnemonic());
		assertEquals(null,item.getAccelerator());
		
		//text with F1 accelerator
		item = (JMenuItem) r.get("menu5");
		assertEquals("New...", item.getText());
		assertEquals(0,item.getMnemonic());
		assertEquals(f1,item.getAccelerator());
		
		//buttons with just text
		JButton button = (JButton) r.get("button1");
		assertEquals("New", button.getText());
		assertEquals(0,button.getMnemonic());

		//buttons with mnemonics
		button = (JButton) r.get("button2");
		assertEquals("New", button.getText());
		assertEquals(KeyEvent.VK_N,button.getMnemonic());
		
	}
	
	@Test
	public void issue62_JInternalFrame() {
		BuildResult r = new SwingYamlBuilder("JFrame(name=main,title=Main Frame):") {{
			___("- JDesktopPane(name=desktop):");
			_____("- JInternalFrame(name=frame1,title='Frame 1')");
			_____("- JInternalFrame(name=frame2,title='Frame 2')");
		}}.build(this);
		
		JFrame f = (JFrame) r.getRoot();
		JDesktopPane desktop = (JDesktopPane) f.getContentPane();
		assertNotNull(desktop);
		
		JInternalFrame frame1 = (JInternalFrame) desktop.getComponent(0);
		assertNotNull(frame1);
		JInternalFrame frame2 = (JInternalFrame) desktop.getComponent(1);
		assertNotNull(frame2);

	}

	@Test
	public void issue65_NPEOnKeyReleased() {
		BuildResult r = new SwingYamlBuilder("JFrame(name=keyBug):") {{
			___("- JLabel(name=bugLabel, text=\"Press key to illustrate the bug\")");
			___("- JTextField(name=bugTextField, columns=15, onKeyReleased=hello)");
		}}.build(this);
		
		JTextField bugTextField = (JTextField) r.get("bugTextField");
		KeyListener kl = bugTextField.getKeyListeners()[0];
		assertNotNull(kl);
		
		kl.keyPressed(null);
			  
	}
	
	@Test
	public void issue71_UnderscoresInNames() {
		BuildResult r = new SwingYamlBuilder("JFrame(name=keyBug):") {{
			___("- JLabel(name=bug_label)");
			___("- MigLayout: bug_label");
		}}.build(this);
	}
	
	@Test
	public void issue72_JPasswordField() {
		BuildResult r = new SwingYamlBuilder("JFrame(name=keyBug):") {{
			___("- JPasswordField(name=password)");
		}}.build(this);
		
		JPasswordField jpf = (JPasswordField) r.get("password");
		assertNotNull(jpf);
		
	}
	
	@Test 
	public void issue70_componentSizeInMigLayoutDsl() {
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JLabel(name=label)");
			___("- JTextField(name=text)");
			___("- JButton(name=button)");
			___("- MigLayout: label< text> button|");
		}}.build(this);
	}
	
	@Test(expected=BuildException.class)
	public void issue67_fileNameInErrors() {
		
		try {
			Issue67 panel = new Issue67();
		} catch (BuildException ex) {
			assertTrue(ex.getMessage().startsWith("Errors found in file: Issue67.yml"));
			throw ex;
		}
		
	}
	
	@Test
	public void issue66_parenthesesInCommentsCounted() {
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- JLabel(name=label) #this is a comment)\"");
			___("- JTextField(name=text)");
			___("- JButton(name=button)");
		}}.build(this);
	}
	
	@Test
	public void issue77_JSeparatorFailsToVerticalAlign() {
		Issue77 p = new Issue77();
		assertEquals("cell 0 1, growx, aligny center",p.getSepConstraints());
	}
	
	@Test(expected=BuildException.class)
	public void issue80_betterErrorOnMissingColon() {
		try {
			BuildResult r = new SwingYamlBuilder("JPanel(name=toto)") {{
				___("- JLabel(name=label)");
			}}.build(this);
			
		} catch (BuildException ex) {
			assertEquals("\":\" is missing after \"JPanel(name=toto)\", as list is started on next line", ex.getMessage());
			throw ex;
		}
	}
	
	@Test
	public void issue109_actionNameNotFound() {
		//no internationalization
		BuildResult r = new SwingYamlBuilder("JFrame:") {{
			___("- Action(name=ablageSearchAction, text=search.text, onAction=hello, enabled=true)");
			___("- JPanel(name=ablageButtons):");
			_____("- JButton(name=ablageSearchButton, action=ablageSearchAction)");
		}}.build(this);
		
		//add internationalization without marking of invalid resources - should still work, with warnings
		BuildResult r2 = new SwingYamlBuilder("JFrame:") {{
			___("- Action(name=ablageSearchAction, text=search.text, onAction=hello, enabled=true)");
			___("- JPanel(name=ablageButtons):");
			_____("- JButton(name=ablageSearchButton, action=ablageSearchAction)");
		}}.build(this, ResourceBundle.getBundle("TestResources"));

		//add internationalization WITH marking of invalid resources - should still work, with warnings
		try {
			SwingJavaBuilder.getConfig().setMarkInvalidResourceBundleKeys(true);
			
			BuildResult r3 = new SwingYamlBuilder("JFrame:") {{
				___("- Action(name=ablageSearchAction, text=search.text, onAction=hello, enabled=true)");
				___("- JPanel(name=ablageButtons):");
				_____("- JButton(name=ablageSearchButton, action=ablageSearchAction)");
			}}.build(this, ResourceBundle.getBundle("TestResources"));
		} finally {
			SwingJavaBuilder.getConfig().setMarkInvalidResourceBundleKeys(false);
		}
 
	}
	
	/**
	 * Ensure background dialog works regardless of YAML extension
	 * @throws IOException 
	 * @throws BuildException 
	 */
	@Test
	public void issue114_supportYamlExtensionAndBackgroundDialog() throws BuildException, IOException {
		BuildResult r = new SwingYamlBuilder("JFrame:") {{
			___("- Action(name=ablageSearchAction, text=search.text, onAction=hello, enabled=true)");
			___("- JPanel(name=ablageButtons):");
			_____("- JButton(name=ablageSearchButton, action=ablageSearchAction)");
		}}.build(this);
		BackgroundDialog dialog = new BackgroundDialog(new BackgroundEvent(this,this,true,  r), r);
		
		//change extension and ensure it still works
		String ext = SwingJavaBuilder.getConfig().getYamlExtension();
		try {
			SwingJavaBuilder.getConfig().setYamlExtension(".something");
			BackgroundDialog dialog2 = new BackgroundDialog(new BackgroundEvent(this,this,true,  r), r);
		} finally {
			SwingJavaBuilder.getConfig().setYamlExtension(ext);
		}
	}
	
	@Test
	public void issue118_multipleEmbeddedStringWithSameValue() {
		BuildResult r = new SwingYamlBuilder("JPanel:") {{
			___("- MigLayout: |\n            \"miles\" \"miles\"");
		}}.build(this);
		
		assertNotNull(r.get("lblMiles"));
		assertEquals(JLabel.class,r.get("lblMiles").getClass());
		assertEquals(JLabel.class,r.get("lblMiles2").getClass());
	}
	
	@Test
	public void issue115_defaultValuesForEmbeddedStrings() {
		try {
			//set a default value for JLabel
			SwingJavaBuilder.getConfig().forType(JLabel.class).defaultValue("font", "Monospace 14pt bold");
			
			BuildResult r = new SwingYamlBuilder("JPanel:") {{
				___("- MigLayout: |\n            \"miles\" ");
			}}.build(this);
			
			assertNotNull(r.entrySet().toString(),r.get("lblMiles"));
			assertEquals(JLabel.class,r.get("lblMiles").getClass());

			JLabel label = (JLabel) r.get("lblMiles");
			assertEquals("Monospace",label.getFont().getName());
			assertEquals(14,label.getFont().getSize());
			assertEquals(true,label.getFont().isBold());
			assertEquals(false,label.getFont().isItalic());
			assertEquals(false,label.getFont().isPlain());
			
		} finally {
			SwingJavaBuilder.getConfig().forType(JLabel.class).defaultValue("font", null);
		}
	}
	
	@Test
	public void issue125_absoluteBuildFileLocation() {
		Issue125 issue = new Issue125();
		assertNotNull("Components were not build correctly", issue.someButton);
		
	}
	
	//internal test method
	private void hello() {}


}